Customer transactions

cURL

curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/customers/{id}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brand_id": "<string>",
      "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "funded_by": "MARKETING",
      "event_type": "PURCHASE",
      "reward_type": "POINTS",
      "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "cost": 123,
      "details": "<string>",
      "type": "ACCUMULATION",
      "receiver_id": "<string>",
      "sender_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "attributes": {
        "line": {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        },
        "campaign_name": "<string>"
      },
      "metadata": {}
    }
  ]
}

GET

customers

{id}

transactions

cURL

curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/customers/{id}/transactions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brand_id": "<string>",
      "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "store_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "funded_by": "MARKETING",
      "event_type": "PURCHASE",
      "reward_type": "POINTS",
      "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "cost": 123,
      "details": "<string>",
      "type": "ACCUMULATION",
      "receiver_id": "<string>",
      "sender_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "attributes": {
        "line": {
          "amount": 123,
          "reward_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "issued_at": "2023-11-07T05:31:56Z",
          "expiration_date": "2023-11-07T05:31:56Z",
          "reservation_expires_at": "2023-11-07T05:31:56Z"
        },
        "campaign_name": "<string>"
      },
      "metadata": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The customer unique identifier in your system

Query Parameters

year

number

The year to filter transactions

Required range: x >= 2020

brand_id

string

The brand id to filter transactions

reward_id

string<uuid>

The reward id to filter transactions

type

enum<string>

The transaction type to filter transactions

Available options:

ACCUMULATION,

REDEMPTION,

EXPIRATION,

MIGRATION,

TRANSFER,

REVERSAL

Response

data

object[]

Show child attributes

data.id

string<uuid>

The transaction internal unique identifier

data.brand_id

string | null

The brand id of the transaction

data.event_id

string<uuid> | null

The id of the event the created the transaction

data.campaign_id

string<uuid> | null

The id of the campaign that created the transaction

data.channel_id

string<uuid> | null

The id of the channel that created the transaction

data.store_id

string<uuid> | null

The id of the store that created the transaction

data.funded_by

string | null

Who funded the rewards used in this transaction

Example:

"MARKETING"

data.event_type

string

The type of the event that created the transaction

Example:

"PURCHASE"

data.reward_type

enum<string>

The type of the reward used in the transaction

Available options:

POINTS,

DISCOUNT,

GIFT_CARD,

PRODUCT

data.reward_id

string<uuid>

The reward id of the transaction

data.amount

number

The amount of the transaction

data.cost

number | null

The cost of the rewards used in the transaction

data.details

string

The explanation of why transaction was created

data.type

enum<string>

The type of the transaction

Available options:

ACCUMULATION,

REDEMPTION,

EXPIRATION,

MIGRATION,

TRANSFER,

REVERSAL

data.receiver_id

string

The receiver id of the transaction

data.sender_id

string

The sender id of the transaction

data.created_at

string<date-time>

The date when the transaction was created

data.issued_at

string<date-time>

The date when the transaction was issued

data.attributes

object

The attributes of the transaction

Show child attributes

data.attributes.line

object

required

The line used to create the transaction

Show child attributes

data.attributes.line.amount

number

The amount of the line

data.attributes.line.reward_id

string<uuid>

The reward id of the line

data.attributes.line.campaign_id

string<uuid> | null

The campaign id of the line

data.attributes.line.brand_id

string<uuid> | null

The id of the brand that originated the line

data.attributes.line.issued_at

string<date-time>

The date when the line was issued

data.attributes.line.expiration_date

string<date-time>

The expiration date of the line

data.attributes.line.reservation_expires_at

string<date-time> | null

The reservation expiration date of the line

data.attributes.campaign_name

string

The name of the campaign that created the transaction

data.metadata

object

The metadata of the transaction

Create a new campaign Account transactions

⌘I

API Documentation

Endpoints

Guides

Resources

Customer transactions

Authorizations

Path Parameters

Query Parameters

Response